Skip to main content

Endpoint Diagnostics

Route

/v2/endpoint-management/endpoints/{id}/diagnostics

Description

List, request, or delete diagnostic captures for a specific endpoint.

Methods

  • GET — list available diagnostics for the endpoint
  • POST — request a new diagnostic capture
  • DELETE — delete diagnostics for the endpoint

Inputs

ParameterTypeRequiredDescription
idstringYesEndpoint ID in the path
typeDiagnosticTypeYes (POST)Diagnostic type to collect (for example logs, sysdiag, perf)
forcebooleanNo (POST)Create a new capture even if one already exists

Request Example (POST)

{
"type": "logs",
"force": true
}

Output (GET/POST)

FieldTypeDescription
typestringAlways "diagnostics"
sizeintegerNumber of diagnostics returned
resourcesarray[Diagnostic]Diagnostic objects
errorsarray[Error]Any errors

Diagnostic Object (key fields)

FieldTypeDescription
endpoint_idstringEndpoint ID
sequenceintegerDiagnostic sequence number
typestringDiagnostic type
statusstringDiagnostic status (pending, completed, error)
errorstringError message when status is error

Rate Limit

  • 60 requests per minute per API key
  • 5 concurrent requests per endpoint

Example Response (GET)

{
"type": "diagnostics",
"size": 1,
"resources": [
{
"endpoint_id": "endpoint-6fcd9b90-41f7-4ed6-a3a1-9fd6efb7c9aa",
"sequence": 1,
"type": "logs",
"status": "completed"
}
],
"errors": []
}